home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 4 / Apprentice-Release4.iso / Source Code / Libraries / C Internet Config / IC Component Source ƒ / IC Resource ƒ / IC Headers ƒ / IC Component API Descriptions.h < prev    next >
Encoding:
C/C++ Source or Header  |  1995-11-17  |  22.2 KB  |  454 lines  |  [TEXT/SPM ]
  1. /*
  2.     Component Interface.h
  3.     
  4.     Describes the component interface routines and their parameters.
  5.     
  6.     Important note about naming conventions:  Read the file "API Readme.h" to understand
  7.     the prefixes used in all of the calls...
  8. */
  9.  
  10. #if 0 // don't include into compilation of code
  11.  
  12. /* ***** Starting Up and Shutting Down ***** */
  13.  
  14. pascal ICError ICCStart(internetConfigurationComponent *inst, OSType creator);
  15. /*
  16.     Call this at application initialisation. Set creator to your application
  17.     creator to allow for future expansion of the IC system. Returns
  18.     inst as a connection to the IC system.
  19. */
  20.  
  21. pascal ICError ICCStop(internetConfigurationComponent inst);
  22. /*
  23.     It is illegal to call this routine inside a ICBegin/End pair.
  24.     
  25.     Call this at application initialisation, after which inst
  26.     is no longer valid connection to IC.
  27. */
  28.  
  29. /* ***** Specifying a Configuration ***** */
  30.  
  31. pascal ICError ICCFindConfigFile(internetConfigurationComponent inst, short count, ICDirSpecArrayPtr folders);
  32. /*
  33.     It is illegal to call this routine inside a ICBegin/End pair.
  34.     
  35.     Call to configure this connection to IC.
  36.     Set count as the number of valid elements in folders.
  37.     Set folders to a pointer to the folders to search.
  38.     Setting count to 0 and folders to nil is OK.
  39.     Searches the specified folders and then the Preferences folder
  40.     in a unspecified manner.
  41. */
  42.  
  43. pascal ICError ICCFindUserConfigFile(internetConfigurationComponent inst, ICDirSpec *where)
  44. /*
  45.     Requires IC 1.1.
  46.     
  47.     It is illegal to call this routine inside a ICBegin/End pair.
  48.     
  49.     Similar to ICFindConfigFile except that it only searches the folder
  50.     specified in where.  If the input parameters are valid the routine
  51.     will always successful configure the instance, creating an
  52.     empty configuration if necessary
  53.     For use with double-clickable preference files.
  54. */
  55.  
  56. pascal ICError ICCGeneralFindConfigFile(internetConfigurationComponent inst, Boolean search_prefs, Boolean can_create,
  57.         short count, ICDirSpecArrayPtr folders)
  58. /*
  59.     Requires IC 1.2.
  60.     
  61.     It is illegal to call this routine inside a ICBegin/End pair.
  62.     
  63.     Call to configure this connection to IC.
  64.     This routine acts as a more general replacement for
  65.     ICFindConfigFile and ICFindUserConfigFile.
  66.     Set search_prefs to true if you want it to search the preferences folder.
  67.     Set can_create to true if you want it to be able to create a new config.
  68.     Set count as the number of valid elements in folders.
  69.     Set folders to a pointer to the folders to search.
  70.     Setting count to 0 and folders to nil is OK.
  71.     Searches the specified folders and then optionally the Preferences folder
  72.     in a unspecified manner.
  73. */
  74.  
  75. pascal ICError ICCChooseConfig(internetConfigurationComponent inst)
  76. /*
  77.     Requires IC 1.2.
  78.     
  79.     It is illegal to call this routine inside a ICBegin/End pair.
  80.     
  81.     Requests the user to choose a configuration, typically using some
  82.     sort of modal dialog. If the user cancels the dialog the configuration
  83.     state will be unaffected.
  84. */
  85.  
  86. pascal ICError ICCChooseNewConfig(internetConfigurationComponent inst)
  87. /*
  88.     Requires IC 1.2.
  89.     
  90.     It is illegal to call this routine inside a ICBegin/End pair.
  91.     
  92.     Requests the user to create a new configuration, typically using some
  93.     sort of modal dialog. If the user cancels the dialog the configuration
  94.     state will be unaffected.
  95. */
  96.  
  97. pascal ICError ICCGetConfigName(internetConfigurationComponent inst, Boolean longname, Str255 name)
  98. /*
  99.     Requires IC 1.2.
  100.     
  101.     You must specify a configuration before calling this routine.
  102.     Returns a string that describes the current configuration at a user
  103.     level. Set longname to true if you want a long name, up to 255
  104.     characters, or false if you want a short name, typically about 32
  105.     characters.
  106.     The returned string is for user display only. If you rely on the
  107.     exact format of it, you will conflict with any future IC
  108.     implementation that doesn't use explicit preference files.
  109. */
  110.  
  111. pascal ICError ICCGetConfigReference(internetConfigurationComponent inst, ICConfigRefHandle ref)
  112. /*
  113.     Requires IC 1.2.
  114.     
  115.     You must specify a configuration before calling this routine.
  116.     Returns a self-contained reference to the instance's current
  117.     configuration.
  118.     ref must be a valid non-nil handle and it will be resized to fit the
  119.     resulting data.
  120. */
  121.  
  122. pascal ICError ICCSetConfigReference(internetConfigurationComponent inst, ICConfigRefHandle ref, long flags)
  123. /*
  124.     Requires IC 1.2.
  125.     
  126.     It is illegal to call this routine inside a ICBegin/End pair.
  127.     
  128.     Reconfigures the instance using a configuration reference that was
  129.     got using ICGetConfigReference reference. Set the
  130.     icNoUserInteraction_bit in flags if you require that this routine
  131.     not present a modal dialog. Other flag bits are reserved and should
  132.     be set to zero.
  133.     ref must not be nil.
  134. */
  135.  
  136. pascal ICError ICCSpecifyConfigFile(internetConfigurationComponent inst, FSSpec *config)
  137. /*
  138.     It is illegal to call this routine inside a ICBegin/End pair.
  139.     
  140.     For use only by the IC application.
  141.     If you call this routine yourself, you will conflict with any
  142.     future IC implementation that doesn't use explicit preference files.
  143. */
  144.  
  145. /* ***** Getting Information ***** */
  146.  
  147. pascal ICError ICCGetSeed(internetConfigurationComponent inst, long *seed)
  148. /*
  149.     You do not have to specify a configuration before calling this routine.
  150.     You do not have to be inside an ICBegin/End pair to call this routine.
  151.     Returns the current seed for the IC prefs database.
  152.     This seed changes each time a non-volatile preference is changed.
  153.     You can poll this to determine if any cached preferences change.
  154. */
  155.  
  156. pascal ICError ICCGetPerm(internetConfigurationComponent inst, ICPerm *perm)
  157. /*
  158.     You do not have to specify a configuration before calling this routine.
  159.     Returns the access permissions currently associated with this instance.
  160.     While applications normally know what permissions they have,
  161.     this routine is designed for use by override components.
  162. */
  163.  
  164. pascal ICError ICCDefaultFileName(internetConfigurationComponent inst, Str63 name)
  165. /*
  166.     You do not have to specify a configuration before calling this routine.
  167.     You do not have to be inside an ICBegin/End pair to call this routine.
  168.     Returns the default file name for IC preference files.
  169.     Applications should never need to call this routine.
  170.     If you rely on information returned by this routine yourself,
  171.     you may conflict with any future IC implementation that doesn't use
  172.     explicit preference files.
  173.     The component calls this routine to set up the default IC file name.
  174.     This allows this operation to be intercepted by a component that has
  175.     captured us. It currently gets it from the component resource file.
  176.     The glue version is hardwired to "Internet Preferences".
  177. */
  178.  
  179. /* ***** Reading and Writing Preferences ***** */
  180.  
  181. pascal ICError ICCBegin(internetConfigurationComponent inst, ICPerm perm)
  182. /*
  183.     You must specify a configuration before calling this routine.
  184.     It is illegal to call this routine inside a ICBegin/End pair.
  185.     Starting reading or writing multiple preferences.
  186.     A call to this must be balanced by a call to ICEnd.
  187.     Do not call WaitNextEvent between these calls.
  188.     The perm specifies whether you intend to read or read/write.
  189.     Only one writer is allowed per instance.
  190.     Note that this may open resource files that are not closed
  191.     until you call ICEnd.
  192. */
  193.  
  194. pascal ICError ICCGetPref(internetConfigurationComponent inst, ConstStr255Param key, ICAttr *attr, Ptr buf, long *size)
  195. /*
  196.     You must specify a configuration before calling this routine.
  197.     If you are getting or setting multiple preferences, you should place
  198.     these calls within an ICBegin/ICEnd pair.
  199.     If you call this routine outside of such a pair, it implicitly
  200.     calls ICBegin(inst, icReadOnlyPerm).
  201.     Reads the preference specified by key from the IC database to the
  202.     buffer pointed to by buf and size.
  203.     key must not be the empty string.
  204.     If buf is nil then no data is returned.
  205.     size must be non-negative.
  206.     attr and size are always set on return. On errors (except icTruncatedErr)
  207.     attr is set to ICattr_no_change and size is set to 0.
  208.     size is the actual size of the data.
  209.     attr is set to the attributes associated with the preference.
  210.     If this routine returns icTruncatedErr then the other returned
  211.     values are valid except that only the first size bytes have been
  212.     return. size is adjusted to reflect the true size of the preference.
  213.     Returns icPrefNotFound if there is no preference for the key.
  214. */
  215.  
  216. pascal ICError ICCSetPref(internetConfigurationComponent inst, ConstStr255Param key, ICAttr attr, Ptr buf, long size)
  217. /*
  218.     You must specify a configuration before calling this routine.
  219.     If you are getting or setting multiple preferences, you should place
  220.     these calls within an ICBegin/ICEnd pair.
  221.     If you call this routine outside of such a pair, it implicitly
  222.     calls ICBegin(inst, icReadWritePerm).
  223.     Sets the preference specified by key from the IC database to the
  224.     value pointed to by buf and size.
  225.     key must not be the empty string.
  226.     size must be non-negative. 
  227.     If buf is nil then the preference value is not set and size is ignored.
  228.     If buf is not nil then the preference value is set to the size
  229.     bytes pointed to by buf.
  230.     If attr is ICattr_no_change then the preference attributes are not set.
  231.     Otherwise the preference attributes are set to attr.
  232.     Returns icPermErr if the previous ICBegin was passed icReadOnlyPerm.
  233.     Returns icPermErr if current attr is locked, new attr is locked and buf <> nil.
  234. */
  235.  
  236. pascal ICError ICCFindPrefHandle(internetConfigurationComponent inst, ConstStr255Param key, ICAttr *attr, Handle prefh)
  237. /*
  238.     Requires IC 1.2.
  239.     
  240.     You must specify a configuration before calling this routine.
  241.     If you are getting or setting multiple preferences, you should place
  242.     these calls within an ICBegin/ICEnd pair.
  243.     If you call this routine outside of such a pair, it implicitly
  244.     calls ICBegin(inst, icReadWritePerm).
  245.     This routine effectively replaces ICGetPrefHandle.
  246.     Reads the preference specified by key from the IC database into
  247.     a handle, prefh.
  248.     key must not be the empty string.
  249.     attr is set to the attributes associated with the preference.
  250.     You must set prefh to a non-nil handle before calling this routine.
  251.     If the preference does not exist, icPrefNotFoundErr is returned.
  252. */
  253.  
  254. pascal ICError ICCGetPrefHandle(internetConfigurationComponent inst, ConstStr255Param key, ICAttr *attr, Handle *prefh)
  255. /*
  256.     Requires IC 1.1.
  257. igurationComponent inst, ConstStr255Param hint, Ptr data, long len,
  258.         long *selStart, long *selEnd, Handle url)
  259. /*
  260.     Requires IC 1.1.
  261.     
  262.     You must specify a configuration before calling this routine.
  263.     You do not have to be inside an ICBegin/End pair to call this routine.
  264.     Parses a URL out of the specified text and returns it in a canonical form
  265.     in a handle.
  266.     hint indicates the default scheme for URLs of the form "name@address".
  267.     If hint is the empty string then URLs of that form are not allowed.
  268.     data points to the start of the text. It must not be nil.
  269.     len indicates the length of the text. It must be non-negative.
  270.     selStart and selEnd should be passed in as the current selection of
  271.     the text. This selection is given in the same manner as TextEdit,
  272.     ie if selStart = selEnd then there is no selection only an insertion
  273.     point. Also selStart ≤ selEnd and 0 ≤ selStart ≤ len and 0 ≤ selEnd ≤ len.
  274.     selStart and selEnd are returned as the bounds of the URL. If the
  275.     routine returns an error then these new boundaries may be
  276.     invalid but they will be close.
  277.     The incoming url handle must not be nil.  The resulting URL is normalised
  278.     and copied into the url handle, which is resized to fit.
  279. */
  280.  
  281. pascal ICError ICCLaunchURL(internetConfigurationComponent inst, ConstStr255Param hint, Ptr data, long len,
  282.         long *selStart, long *selEnd)
  283. /*
  284.     Requires IC 1.1.
  285.     
  286.     You must specify a configuration before calling this routine.
  287.     You do not have to be inside an ICBegin/End pair to call this routine.
  288.     Parses a URL out of the specified text and feeds it off to the
  289.     appropriate helper.
  290.     hint indicates the default scheme for URLs of the form "name@address".
  291.     If hint is the empty string then URLs of that form are not allowed.
  292.     data points to the start of the text. It must not be nil.
  293.     len indicates the length of the text. It must be non-negative.
  294.     selStart and selEnd should be passed in as the current selection of
  295.     the text. This selection is given in the same manner as TextEdit,
  296.     ie if selStart = selEnd then there is no selection only an insertion
  297.     point. Also selStart ≤ selEnd and 0 ≤ selStart ≤ len and 0 ≤ selEnd ≤ len.
  298.     selStart and selEnd are returned as the bounds of the URL. If the
  299.     routine returns an error then these new boundaries may be
  300.     invalid but they will be close.
  301.     The URL is parsed out of the text and passed off to the appropriate
  302.     helper using the GURL AppleEvent.
  303. */
  304.  
  305. /* ***** Mappings Routines *****
  306.  * 
  307.  * Routines for interrogating mappings database.
  308.  * 
  309.  * ----- High Level Routines -----
  310.  */
  311.  
  312. pascal ICError ICCMapFilename(internetConfigurationComponent inst, ConstStr255Param filename, ICMapEntry *entry)
  313. /*
  314.     Requires IC 1.1.
  315.     
  316.     You must specify a configuration before calling this routine.
  317.     If you are getting or setting multiple preferences, you should place
  318.     these calls within an ICBegin/ICEnd pair.
  319.     If you call this routine outside of such a pair, it implicitly
  320.     calls ICBegin(inst, icReadWritePerm).
  321.     Takes the name of an incoming file and returns the most appropriate
  322.     mappings database entry, based on its extension.
  323.     filename must not be the empty string.
  324.     Returns icPrefNotFoundErr if no suitable entry is found.
  325. */
  326.  
  327. pascal ICError ICCMapTypeCreator(internetConfigurationComponent inst, OSType fType, OSType fCreator,
  328.         ConstStr255Param filename, ICMapEntry *entry)
  329. /*
  330.     Requires IC 1.1.
  331.     
  332.     You must specify a configuration before calling this routine.
  333.     You must be inside an ICBegin/End pair to call this routine.
  334.     Takes the type and creator (and optionally the name) of an outgoing
  335.     file and returns the most appropriate mappings database entry.
  336.     The filename may be either the name of the outgoing file or
  337.     the empty string.
  338.     Returns icPrefNotFoundErr if no suitable entry found.
  339. */
  340.  
  341. /* ----- Mid Level Routines ----- */
  342.  
  343. pascal ICError ICCMapEntriesFilename(internetConfigurationComponent inst, Handle entries, ConstStr255Param filename,
  344.         ICMapEntry *entry)
  345. /*
  346.     Requires IC 1.1.
  347.     
  348.     You must specify a configuration before calling this routine.
  349.     You do not have to be inside an ICBegin/End pair to call this routine.
  350.     Takes the name of an incoming file and returns the most appropriate
  351.     mappings database entry, based on its extension.
  352.     entries must be a handle to a valid IC mappings database preference.
  353.     filename must not be the empty string.
  354.     Returns icPrefNotFoundErr if no suitable entry is found.
  355. */
  356.  
  357. pascal ICError ICCMapEntriesTypeCreator(internetConfigurationComponent inst, Handle entries, OSType fType, OSType fCreator,
  358.         ConstStr255Param filename, ICMapEntry *entry)
  359. /*
  360.     Requires IC 1.1.
  361.     
  362.     You must specify a configuration before calling this routine.
  363.     You do not have to be inside an ICBegin/End pair to call this routine.
  364.     Takes the type and creator (and optionally the name) of an outgoing
  365.     file and returns the most appropriate mappings database entry.
  366.     entries must be a handle to a valid IC mappings database preference.
  367.     The filename may be either the name of the outgoing file or
  368.     the empty string.
  369.     Returns icPrefNotFoundErr if no suitable entry found.
  370. */
  371.  
  372. /* ----- Low Level Routines ----- */
  373.  
  374. pascal ICError ICCCountMapEntries(internetConfigurationComponent inst, Handle entries, long *count)
  375. /*
  376.     Requires IC 1.1.
  377.     
  378.     You must specify a configuration before calling this routine.
  379.     You do not have to be inside an ICBegin/End pair to call this routine.
  380.     Counts the number of entries in the mappings database.
  381.     entries must be a handle to a valid IC mappings database preference.
  382.     count is set to the number of entries.
  383. */
  384.  
  385. pascal ICError ICCGetIndMapEntry(internetConfigurationComponent inst, Handle entries, long ndx, long *pos, ICMapEntry *entry)
  386. /*
  387.     Requires IC 1.1.
  388.     
  389.     You must specify a configuration before calling this routine.
  390.     You do not have to be inside an ICBegin/End pair to call this routine.
  391.     Gets the ndx'th entry in the mappings database.
  392.     entries must be a handle to a valid IC mappings database preference.
  393.     ndx must be in the range from 1 to the number of entries in the database.
  394.     The value of pos is ignored on input. pos is set to the position of
  395.     the ndx'th entry in the database and is suitable for passing back
  396.     into ICSetMapEntry.
  397.     Does not return any user data associated with the entry.
  398. */
  399.  
  400. pascal ICError ICCGetMapEntry(internetConfigurationComponent inst, Handle entries, long pos, ICMapEntry *entry)
  401. /*
  402.     Requires IC 1.1.
  403.     
  404.     You must specify a configuration before calling this routine.
  405.     You do not have to be inside an ICBegin/End pair to call this routine.
  406.     Returns the entry located at position pos in the mappings database.
  407.     entries must be a handle to a valid IC mappings database preference.
  408.     pos should be 0 to get the first entry. To get the subsequent entries, add
  409.     entry.total_size to pos and iterate.
  410.     Does not return any user data associated with the entry.
  411. */
  412.  
  413. pascal ICError ICCSetMapEntry(internetConfigurationComponent inst, Handle entries, long pos, ICMapEntry *entry)
  414. /*
  415.     Requires IC 1.1.
  416.     
  417.     You must specify a configuration before calling this routine.
  418.     You do not have to be inside an ICBegin/End pair to call this routine.
  419.     Sets the entry located at position pos in the mappings database.
  420.     entries must be a handle to a valid IC mappings database preference.
  421.     pos should be either a value returned from ICGetIndMapEntry or a value
  422.     calculated using ICGetMapEntry.
  423.     entry is a var parameter purely for stack space reasons. It is not
  424.     modified in any way.
  425.     Any user data associated with the entry is unmodified.
  426. */
  427.  
  428. pascal ICError ICCDeleteMapEntry(internetConfigurationComponent inst, Handle entries, long pos)
  429. /*
  430.     Requires IC 1.1.
  431.     
  432.     You must specify a configuration before calling this routine.
  433.     You do not have to be inside an ICBegin/End pair to call this routine.
  434.     Deletes the mappings database entry at pos.
  435.     entries must be a handle to a valid IC mappings database preference.
  436.     pos should be either a value returned from ICGetIndMapEntry or a value
  437.     calculated using ICGetMapEntry.
  438.     Also deletes any user data associated with the entry.
  439. */
  440.  
  441. pascal ICError ICCAddMapEntry(internetConfigurationComponent inst, Handle entries, ICMapEntry *entry)
  442. /*
  443.     Requires IC 1.1.
  444.     
  445.     You must specify a configuration before calling this routine.
  446.     You do not have to be inside an ICBegin/End pair to call this routine.
  447.     Adds an entry to the mappings database.
  448.     entries must be a handle to a valid IC mappings database preference.
  449.     The entry is added to the end of the entries database.
  450.     No user data is added.
  451. */
  452.  
  453. #endif
  454.